home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / Timing / AlarmingClock.lha / AlarmingClock / AlarmingClock.doc < prev    next >
Text File  |  1993-03-27  |  9KB  |  217 lines
  1. *==========================================================================*
  2. ||                                                                        ||
  3. ||                  AlarmingClock © 1993 by Brian G. Neal                 ||
  4. ||                                                                        ||
  5. ||            THIS PROGRAM IS COPYRIGHT 1992 BY BRIAN G. NEAL.            ||
  6. ||                  PLEASE READ THE FOLLOWING LEGAL MUSH                  ||
  7. ||                                                                        ||
  8. || Permission is hereby granted to distribute this program's              ||
  9. || executable and documentation for non-commercial purposes, so long as   ||
  10. || the executable and documentation are not modified in any way.          ||
  11. || This program may not be distributed for a profit without the express   ||
  12. || written consent of the author Brian G. Neal.                           ||
  13. ||                                                                        ||
  14. || This program is not in the public domain.                              ||
  15. ||                                                                        ||
  16. || Fred Fish is expressly granted permission to distribute this program's ||
  17. || executable and documentation as part of the "Fred Fish freely          ||
  18. || redistributable Amiga software library."                               ||
  19. ||                                                                        ||
  20. *==========================================================================*
  21.  
  22. AlarmingClock is another fine product brought to you by Brian Neal of
  23. Xarxas Technologies.  Please also try StarBlank, the screen blanker
  24. commodity that shows a moving star field.
  25.  
  26. AlarmingClock 2.5 Documentation - March 27, 1993
  27.  
  28. WHAT IS IT?
  29. ===========
  30.  
  31.    AlarmingClock is an alarm clock program that plays IFF 8SVX sound files
  32. for the alarm.  It runs from the Workbench or the shell.  It features an
  33. easy to use gadget interface and even a snooze button!  AlarmingClock can
  34. also open up on a public screen, use the asl file requester, and has many 
  35. startup options.
  36.  
  37. REQUIREMENTS
  38. ============
  39.  
  40.    You need an Amiga running (at least?) release 2 of the operating system.
  41. You also need a few of your favorite IFF 8SVX sampled sound files.
  42.  
  43. HOW TO RUN
  44. ==========
  45.  
  46.    From the shell you start AlarmingClock by using the following syntax:
  47.  
  48.       aclock SOUND,ALARM/N,LEFT/N,TOP/N,SNOOZE/N,24HOUR/S,PUBSCREEN/K,
  49.              FLASH/K,CHIME/K
  50.  
  51. See your Amiga documentation for the meaning of the notation (its quite
  52. easy, actually).  Note that with version 2.3, the sound argument is no
  53. longer required.  If it is missing AlarmingClock will open the system
  54. file requester for you.  Explanation below, but here are some examples:
  55.  
  56.       aclock work:sounds/fx/boom.snd
  57.       aclock kapow.8svx 1300
  58.       aclock kablam.iff ALARM=1300 SNOOZE 2
  59.       aclock bang.snd 730 0 0 10 24hour
  60.       aclock sound bang.snd left 0 TOP 0 snooze 10 24HOUR
  61.       aclock music:fx/prong.snd PUBSCREEN MegaCommScreen
  62.       aclock top 0 left=200 24hour alarm 800
  63.       aclock sounds:pow.iff flash=NO chime=hour
  64.  
  65.  
  66. If you want to put AlarmingClock in your S:User-Startup file, make sure
  67. you start it with:
  68.  
  69.       run aclock <NIL: >NIL: ....
  70.  
  71. so the initial shell window will close.
  72.  
  73.    From the Workbench, simply double click the aclock icon.  The following
  74. tool types are supported.
  75.  
  76.    SOUND=soundfile
  77.    ALARM=alarmtime
  78.    LEFT=x
  79.    TOP=y
  80.    SNOOZE=snoozetime
  81.    24HOUR
  82.    PUBSCREEN=pubscreenname
  83.    FLASH=yes_or_no
  84.    CHIME=chime_type
  85.    DONOTWAIT
  86.  
  87.    Here is an explanation of the parameters for both shell and Workbench
  88. use.
  89.  
  90. SOUND=name     This is the optional name of the IFF 8SVX sound file
  91.  
  92. ALARM=dddd     This is optional time you want the alarm to go off, given in
  93.                24 hour notation.  E.g.  1910
  94.  
  95. LEFT=n         The optional initial left edge of AlarmingClock's window
  96.  
  97. TOP=n          The optional initial top edge of AlarmingClock's window
  98.  
  99. SNOOZE=n       The optional time you defer the alarm when hitting the snooze
  100.                button.  If not present, the default is 5 minutes.
  101.  
  102. 24HOUR         If present AlarmingClock will startup in 24 hr. mode.  The
  103.                default is 12 hr. mode.
  104.  
  105. PUBSCREEN=name The optional name of the public screen to open on.
  106.                Defaults to Workbench.
  107.  
  108. FLASH=answer   If this is not NO, AlarmingClock will flash all screens when
  109.                the alarm goes off.  I added this option because Workbench 2.1
  110.                can play a sound when a screen is flashed, and I did not
  111.                like both sounds playing simultaneously.  The default is YES.
  112.  
  113. CHIME=type     Valid choices are NO, SINGLE, or HOUR.  A SINGLE chime means
  114.                AlarmingClock will play your sound once at the beginning of
  115.                every hour.  A HOUR chime means that AlarmingClock will play
  116.                your sound n times if it's n o'clock.  A choice of NO disables
  117.                the chime feature.  Of course, you can have both a chime and
  118.                the alarm set simultaneously.  The default chime type is NO.
  119.  
  120. DONOTWAIT      This is a tool type only.  If you put AlarmingClock in your
  121.                WBStartup drawer have this tool type present so the initial
  122.                shell window will close.
  123.  
  124. HOW TO USE
  125. ==========
  126.  
  127.    If you start AlarmingClock with no sound filename, it will open the
  128. system file requester.  Use the requester to select your IFF 8SVX sound
  129. file.  Next, AlarmingClock will present a small window (just a title
  130. bar actually) displaying the time.  To access the control panel, click the
  131. right mouse button when the window is active.  I hope that the operation is
  132. painfully obvious from here.  The current time is displayed in the recessed
  133. area marked "Current", the alarm time is displayed in the area marked
  134. "Alarm".  Change the alarm time with the sliders.  Change between 12 & 24
  135. hr. mode with the cycle gadget.  Hit "Test" to hear the alarm sound file.
  136. The "Alarm Set" gadget sets/unsets the alarm.  The ZZZ gadget is the snooze
  137. button.  When the alarm is ringing this gadget will become available.
  138. Clicking it turns off the alarm and advances the alarm time by the amount
  139. you specified with the SNOOZE parameter (default is 5 minutes).  Click the
  140. right mouse button at any time to return to the smaller time only display.
  141.  
  142.    The Chime gadget controls AlarmingClock's hourly chime feature.  See
  143. the above explanation of the CHIME tool type/argument.
  144.  
  145. CAVEATS
  146. =======
  147.  
  148.    This program was developed on an Amiga 3000 running 2.1.  I would
  149. appreciate any feedback on how AlarmingClock performs (or not performs)
  150. on the newer machines and under 3.0.
  151.  
  152. A CAUTIONARY NOTE ON MULTITASKING
  153. =================================
  154.  
  155.    The Amiga (currently, fingers crossed) has 4 audio channels.  Thus
  156. in a multitasking environment these can become scarce resources.  Programs
  157. must be written to share these channels to make the user happy.  Sharing
  158. is a 2 way street.  I think that AlarmingClock will live up to its side
  159. of the bargain.  It only allocates a channel when it needs to play the
  160. alarm, plays it, then releases the channel.  If your system crashes or
  161. AlarmingClock doesn't play the alarm, chances are you are also running an
  162. audio hog program.  Such programs typically write directly to the hardware
  163. or lock all 4 channels.  I do know that Marc Espie followed the rules, and
  164. his wonderful module player Experiment IV will coexist peacefully with
  165. AlarmingClock.  EDPlayer seems to lock out AlarmingClock.
  166. I haven't tried it with any other module players.
  167.  
  168. DIFFERENCES BETWEEN VERSION 2.5 AND 2.4
  169. =======================================
  170.  
  171. - Better job of keeping the title bar trash free.
  172. - FLASH argument added.
  173. - Chime feature added.
  174.  
  175. DIFFERENCES BETWEEN VERSION 2.4 AND 2.3
  176. =======================================
  177.  
  178. - Version 2.4 now uses iffparse.library to read and parse sounds.
  179. - AlarmingClock can now handle sound files compressed with the
  180.   Fibonacci-Delta compression algorithm (do any of these exist?).
  181. - Bug squashed relating to determining PAL or NTSC machine type.
  182.   
  183. DIFFERENCES BETWEEN VERSION 2.3 AND 2.2
  184. =======================================
  185.  
  186.    Version 2.3 no longer requires you to supply the name of the alarm
  187. file.  If it is not given, AlarmingClock will open the system file
  188. requester and let you choose one that way.
  189.    AlarmingClock will now exit when it receives a CTRL-C.
  190.  
  191. EPILOGUE
  192. ========
  193.  
  194.    Thanks for using AlarmingClock.  Please send me any comments, flames,
  195. bug reports, suggestions, misplaying sound files, etc.  This program
  196. was written for fun, but donations will not be turned away :^).  They
  197. will also encourage me to implement your suggestions!  I hope you enjoy
  198. this program!
  199.  
  200. Thanks go to:
  201.  
  202.    - Dan Kline for suggesting the hourly chime.
  203.    - Terry Austin for beta testing and sending me sounds!
  204.    - Charles Wuethrich for suggesting the snooze button (good one!)
  205.    - Fred Fish for publishing a *VERY* crude and young version
  206.      of this program.  Thanks also for the great software library.
  207.    - The Amiga software engineers
  208.  
  209.    Please, someone design a better icon!
  210.  
  211. Brian Neal
  212. 106 Mabel Court Apt. D
  213. Morris, IL 60450
  214. USA
  215.  
  216. GEnie:   B.NEAL2
  217.